home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / video / vlcallbacks.z / vlcallbacks
Encoding:
Text File  |  1998-10-20  |  9.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. VVVVLLLLAAAADDDDDDDDCCCCAAAALLLLLLLLBBBBAAAACCCCKKKK((((3333ddddmmmm))))                                          VVVVLLLLAAAADDDDDDDDCCCCAAAALLLLLLLLBBBBAAAACCCCKKKK((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      vlRegisterHandler, vlRemoveHandler, vlAddCallback, vlRemoveCallback,
  10.      vlRemoveAllCallbacks, vlCallCallbacks, vlMainLoop - IRIS VL event
  11.      handling routines
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////vvvvllll....hhhh>>>>
  15.  
  16.      iiiinnnntttt vvvvllllRRRReeeeggggiiiisssstttteeeerrrrHHHHaaaannnnddddlllleeeerrrr((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, iiiinnnntttt ffffdddd,,,, VVVVLLLLEEEEvvvveeeennnnttttHHHHaaaannnnddddlllleeeerrrr hhhhaaaannnnddddlllleeeerrrr,,,,
  17.                     VVVVLLLLPPPPeeeennnnddddiiiinnnnggggFFFFuuuunnnncccc ppppeeeennnnddddiiiinnnnggggFFFFuuuunnnncccc,,,, vvvvooooiiiidddd ****cccclllliiiieeeennnnttttDDDDaaaattttaaaa))));;;;
  18.      iiiinnnntttt vvvvllllRRRReeeemmmmoooovvvveeeeHHHHaaaannnnddddlllleeeerrrr((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, iiiinnnntttt ffffdddd))));;;;
  19.      iiiinnnntttt vvvvllllAAAAddddddddCCCCaaaallllllllbbbbaaaacccckkkk((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLEEEEvvvveeeennnnttttMMMMaaaasssskkkk eeeevvvveeeennnnttttssss,,,,
  20.                  VVVVLLLLCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc ccccaaaallllllllbbbbaaaacccckkkk,,,, vvvvooooiiiidddd ****cccclllliiiieeeennnnttttDDDDaaaattttaaaa))));;;;
  21.      iiiinnnntttt vvvvllllRRRReeeemmmmoooovvvveeeeCCCCaaaallllllllbbbbaaaacccckkkk((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLEEEEvvvveeeennnnttttMMMMaaaasssskkkk eeeevvvveeeennnnttttssss,,,,
  22.                     VVVVLLLLCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc ccccaaaallllllllbbbbaaaacccckkkk,,,, vvvvooooiiiidddd ****cccclllliiiieeeennnnttttDDDDaaaattttaaaa))));;;;
  23.      iiiinnnntttt vvvvllllRRRReeeemmmmoooovvvveeeeAAAAllllllllCCCCaaaallllllllbbbbaaaacccckkkkssss((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLEEEEvvvveeeennnnttttMMMMaaaasssskkkk eeeevvvveeeennnnttttssss))));;;;
  24.      iiiinnnntttt vvvvllllCCCCaaaallllllllCCCCaaaallllllllbbbbaaaacccckkkkssss((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLEEEEvvvveeeennnntttt ****eeeevvvv))));;;;
  25.      vvvvooooiiiidddd vvvvllllMMMMaaaaiiiinnnnLLLLoooooooopppp(((())));;;;
  26.  
  27. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  28.      _s_v_r           Specifies the video server.
  29.  
  30.      _f_d            a file descriptor that can be used with _s_e_l_e_c_t(2).
  31.  
  32.      _h_a_n_d_l_e_r       Pointer to a function to handle data valid on the file
  33.                    descriptor.
  34.  
  35.      _p_e_n_d_i_n_g_F_u_n_c   Pointer to a function that will tell whether there is data
  36.                    that has been read from the file descriptor, but not passed
  37.                    to a handler function. If this is null, no data will be
  38.                    checked for before entering _s_e_l_e_c_t(2).
  39.  
  40.      _c_l_i_e_n_t_D_a_t_a    Data for the use of the client callback.
  41.  
  42.      _p_a_t_h          The path for which a callback will be invoked, of VL_ANY
  43.                    for all paths.
  44.  
  45.      _e_v_e_n_t_s        Event mask for which add or remove a handler.
  46.  
  47.      _c_a_l_l_b_a_c_k      The callback function to be invoked or removed.
  48.  
  49.      _e_v            A pointer to an event for which you wish event callbacks to
  50.                    be invoked.
  51.  
  52. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  53.      vvvvllllRRRReeeeggggiiiisssstttteeeerrrrHHHHaaaannnnddddlllleeeerrrr is intended to provide a mechanism for receiving events
  54.      from servers other than the VL, e.g., the X server or the GL. After
  55.      vvvvllllMMMMaaaaiiiinnnnLLLLoooooooopppp is given control, the handler function will be called with the
  56.      file descriptor and the client data specified when sssseeeelllleeeecccctttt(2) returns the
  57.      fd as readable.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVLLLLAAAADDDDDDDDCCCCAAAALLLLLLLLBBBBAAAACCCCKKKK((((3333ddddmmmm))))                                          VVVVLLLLAAAADDDDDDDDCCCCAAAALLLLLLLLBBBBAAAACCCCKKKK((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      This function should not be called with the VL file descriptor.
  75.  
  76.      vvvvllllRRRReeeemmmmoooovvvveeeeHHHHaaaannnnddddlllleeeerrrr removes the corresponding handler from the file
  77.      descriptor. There can only be one handler per file descriptor at a time.
  78.      Registering a handler on a file descriptor that already has a handler
  79.      registered will remove the previous handler.  After vvvvllllRRRReeeemmmmoooovvvveeeeHHHHaaaannnnddddlllleeeerrrr is
  80.      called, vvvvllllMMMMaaaaiiiinnnnLLLLoooooooopppp will no longer wait on the file descriptor using
  81.      sssseeeelllleeeecccctttt ((((2222))))
  82.  
  83.      vvvvllllAAAAddddddddCCCCaaaallllllllbbbbaaaacccckkkk will add a callback with the specified client data to the
  84.      event mask given. If the callback and the client data match a previous
  85.      callback added on the same server and path, the event masks will be or'ed
  86.      together and the callback will only be called once. If any of the
  87.      parameters differs, all callbacks for a given event will be called, but
  88.      not in a guaranteed sequence. If VL_ANY is given as the path, the
  89.      callback will be called when the events occur on any path. These
  90.      callbacks will be called only if control is given to vvvvllllMMMMaaaaiiiinnnnLLLLoooooooopppp,,,, or
  91.      vvvvllllCCCCaaaallllllllCCCCaaaallllllllbbbbaaaacccckkkkssss is called.
  92.  
  93.      vvvvllllRRRReeeemmmmoooovvvveeeeCCCCaaaallllllllbbbbaaaacccckkkk will remove the given callback from the events in the
  94.      event mask. A callback is only removed if the server, path, and client
  95.      data match exactly. Note that VL_ANY given as a path, will only remove a
  96.      callback that has been registered on VL_ANY.
  97.  
  98.      vvvvllllRRRReeeemmmmoooovvvveeeeAAAAllllllllCCCCaaaallllllllbbbbaaaacccckkkkssss will remove all callbacks on a given path for a set
  99.      of events. Note again that VL_ANY will not match any path.
  100.  
  101.      vvvvllllCCCCaaaallllllllCCCCaaaallllllllbbbbaaaacccckkkkssss will call all the callbacks registered for the server and
  102.      event. The path field in the event must be set properly. This function
  103.      will aid in creating your own main loop, or using one other than
  104.      vlMainLoop.
  105.  
  106.      vvvvllllMMMMaaaaiiiinnnnLLLLoooooooopppp is a select loop that will infinitely loop waiting for events
  107.      to come in on all of the file descriptors registered. If the sssseeeelllleeeecccctttt(2)
  108.      call is interrupted, it will try to re-enter select and continue. This
  109.      function will not return.
  110.  
  111. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  112.      If successful, those routines that return a value will return zero.  A
  113.      value of -1 indicates an error.
  114.  
  115. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  116.      vlSelectEvents(3dm), vlNextEvent(3dm), vlConnectionNumber(3dm)
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.